A estrutura do repositório está dividida nas seguintes pastas:
Nesse momento, devemos procurar se os modelos que serão utilizados como recursos da API já existem.
Ele será encontrado nessa pasta, se algum dos casos abaixo for verdadeiro:
Se não for possível encontrar o JsonSchema na pasta "Schemas", precisamos verificar se já existe um Pull Request existente para aquele schema ou API.
É possível utilizar o filtro baseado na descrição e labels (API, Schema).
Ao encontrar um Pull Request existente, entrar em contato com a equipe que o abriu para alinhar o desenvolvimento.
Se não encontrar, criar uma nova branch para a criação dos JSONs.
ResourceName/ApiVersion/SchemaVersion
API version é iniciada pela letra "V"
Schema version é separado por underline, especificando minor e major
Exemplo: Parameters/V1/1_000
ResourceName/ApiVersion
Exemplo: Parameters/V1
ResourceName/SchemaVersion
Exemplo: Parameters/1_000
O pull request deve ser aberto com o mesmo nome da branch.
Selecionar os labels "API" e "Schema" se nesse pull request existiram alterações nas duas estruturas. Caso contrário, seleciono apenas aquele label que melhor descreve.
A descrição é livre.
Comitê avalia e aprova mensagem
O comitê pode interagir com quem está propondo aqueles schemas e/ou APIs para discutir regras de negócio, e pedir ajustes antes da aprovação.
Da mesma forma, a equipe TTALK interage sobre possíveis problemas na estrutura dos arquivos, padrões definidos e boas práticas, também pedindo ajustes antes da aprovação.
Ao passar por essas duas etapas de aprovação (TTALK e comitê), os arquivos JSON são aprovados e é realizado um merge com a master.