Repository navigation
Docs: páginas do portal conferidas contra o código (pós-6.0.1) - #54
Merged
Merged
Conversation
As paginas de docs/ que o portal espelha tinham assinaturas e retornos
de antes da 6.0.0:
recursos/product-invoices createWithStateTax sem stateTaxId;
sendCorrectionLetter recebia objeto (e
reason: string, sem acento); downloads
de NF-e e da CC-e como Buffer (devolvem
NfeFileResource, { uri }); cancel,
disable e disableRange com outro retorno
recursos/service-invoices downloads com invoiceId opcional e "ZIP
da empresa", com exemplo que nao compila
recursos/state-taxes tipo StateTax, que nao existe (e
NfeStateTax); exemplo com
stateTaxes[0].id, que nao compila em
modo estrito
recursos/legal-entity-lookup getStateTaxInfo e os de IE para emissao
sem o parametro state; exemplo que nao
compila em modo estrito
recursos/legal-people, findByTaxNumber pode devolver undefined
recursos/natural-people
downloads.md "Buffer sempre" e "ZIP por empresa";
NFC-e com environment; faltavam
distribuicao e CT-e
README.md (indice) "bytes binarios e ZIPs"
API.md, EXTENDING.md e EXTENSIBILITY_SUMMARY.md sao da v3: nao tem
frontmatter de portal e so se referenciam entre si. No API.md ha secoes
inteiras erradas, nao so assinaturas. Por decisao do Andre, ganham aviso
de legado no topo, apontando para as paginas mantidas, a skill e os
tipos do pacote; o conteudo nao e reescrito.
Verificado: a comparacao mecanica das paginas de recursos com o codigo
fica so com diferencas de nome de parametro; os exemplos das paginas
tocadas compilam em modo estrito, e quatro usos da versao anterior nao
compilam.
📋 OpenAPI Spec Validation✅ All specs validated and types generated successfully Specs processed:
Generated types available as artifact in |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
O que é
Só documentação, depois da 6.0.1. Não publica nada e não muda versão, porque
docs/não vai nopacote do npm. Este PR vem antes da re-sincronização das páginas no portal de documentação.
O que estava errado
Comparei as páginas de
docs/com o código, pelo mesmo método usado na skill na 6.0.1. Elas tinhamassinaturas e retornos de antes da 6.0.0:
recursos/product-invoices.mdcreateWithStateTaxsemstateTaxId;sendCorrectionLettercom objeto, quando recebereason: string, sem acento; downloads de NF-e e da CC-e comoBuffer, quando devolvem{ uri };cancel,disableedisableRangecom outro retornorecursos/service-invoices.mdinvoiceIdopcional e "ZIP da empresa", com um exemplo que não compilarecursos/state-taxes.mdStateTax, que não existe; exemplo que não compila em modo estritorecursos/legal-entity-lookup.mdgetStateTaxInfoe os métodos de IE para emissão sem o parâmetrostate; exemplo que não compila em modo estritorecursos/legal-people.md,natural-people.mdfindByTaxNumbernão indica que pode devolverundefineddownloads.mdenvironment; não lista distribuição nem CT-eREADME.md(índice)Legado da v3
docs/API.md,docs/EXTENDING.mdedocs/EXTENSIBILITY_SUMMARY.mdnão têm frontmatter de portale só se referenciam entre si. No
API.mdhá seções inteiras erradas: os exemplos delist,cancelesendEmailnão funcionam na v6. Os três ganharam um aviso de legado no topo, que apontapara as páginas mantidas, a skill e os tipos do pacote. O conteúdo não foi reescrito.
Verificação
Depois do merge
Re-sincronizar as páginas da biblioteca Node no portal de documentação (tarefa 8.8 da 6.0.1). A
descrição desse PR passa pela sua aprovação antes de ele ser aberto.