docs(redoc): cria documentação integrada com swagger #124
Conversation
This file contains 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
mateusvrs
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #124 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 43 41 -2
Lines 1099 1027 -72
=========================================
- Hits 1099 1027 -72 ☔ View full report in Codecov by Sentry. |
caio-felipee
approved these changes
Nov 28, 2023
mateusvrs
added a commit
that referenced
this pull request
Nov 28, 2023
…a matéria na api (#125) * fix(Users): Corrige o erro de troca de nome de usuario. - Caso o usuario trocasse de nome no Google, o nome nao era salvo e o usuario nao conseguia logar. * fix(users-name-change): Os dados do usuário são sempre salvos após o login * api(views): update function calling in search api * db(migrations): install Trigram and pt_unaccent * db_handler(search): create new search function * test(db_handler): add test for new function * api(views): throw error when insufficient chars * api(tests): test for search api insufficient chars * make(database): Cria comandos make para atualizar o banco de dados. - Também foram corrigidos comentários no arquivo _updatedb.py_ * api(views): add rota de ano/período disponíveis Co-authored-by: GabrielCastelo-31 <[email protected]> * test(api): verifica retorno da rota ano/período * db(migrations): update migrations * db(models): update special_dates field * api(web-scraping): update functions add intervals * api(web-scraping): improve function complexity * python(requirements): add Unidecode * api(models): add unicode field to search improve * api(views): apply admin search method to endpoint * api(views): change name treatment to func * api(views): update search api - improve user exp * api(search-api-test): remove useless tests * utils(db-handler): update similarity function - also removes search by name function * utils(db-handler): remove useless tests * tests(year-period): add descrição ao teste * apí(commands): rm chars especiais do html do sigaa * api(mock): atualizando mock sem chars especiais * api(utils): melhora o entendimento do código * api(utils): cria func sep. p/start e end das datas * api(utils): separa func start end em duas de index * tests(setup.cfg): config codecov to ignore files * tests(codecov): add codecov "no cover" to ignore * Adiciona foto de perfil aos dados retornados. * docs(update-api): Atualiza os endpoints da API - Todos os endpoints sofrearam alterações Co-authored-by: mateusvrs <[email protected]> * main(readme): update README.md Co-authored-by: mateusvrs <[email protected]> * Update api/utils/web_scraping.py Co-authored-by: Gabriel Henrique Castelo <[email protected]> * Update api/utils/web_scraping.py Co-authored-by: Gabriel Henrique Castelo <[email protected]> * main(readme): remove embeds * Corrige erro causado após correção de tipagem de retorno. -Volta ao bc28e58 * Adiciona tipagem de retorno para funções de web scraping * applying and mergin migrations * fix(utils): get start e end index com return erro * main(readme): fix repo redirects * typo(tests): add pep8 * Revert "api(search): corrige experiência do usuário e adiciona verificações" * Revert "Revert "api(search): corrige experiência do usuário e adiciona verificações"" * docs(redoc): cria documentação integrada com swagger (#124) * python(requirements): adiciona drf_yasg * docs(users): descreve view de registro c/swagger * redoc(api): descreve views de search e year/period * docs(urls): adiciona rota do redoc e swagger * core(settings): swagger aos app django + rota 404 * api(templates): cria página 404 personalizada * docs(api): customiza erros com classe específica * docs(core): adiciona contribuidores ao docs da api * docs(swagger): classe p/padrão de response erros * docs(users): descreve view de login e logout * docs(api): simplifica classe de erro swagger * api(views): atualiza com novo método de filtragem * test(users): erros de acordo com novo padrão * test(config): no cover nos casos de except da docs --------- Co-authored-by: GabrielCastello-31 <[email protected]> Co-authored-by: Caio <[email protected]> Co-authored-by: Gabriel Henrique Castelo <[email protected]>
CaioHabibe
added a commit
that referenced
this pull request
Nov 30, 2023
…dades de busca e seleção de disciplinas (#126) * comecando o Button `adicionar materia` * Typo em rounded no botao * frontend(Home): Layout da pagina home * frontend(home): otimizando layout * frontend(home): Layout home HTML * frontend(home): criação da tela de filtragem de matérias * frontend(Home): Fixed error span boxes * web(comp): cria box modularizada para disciplina * frontend(home): criação do botão na div addClass * web(tailwind): adiciona cores padrão do projeto * web(api): cria arquivo separado para settings axios * web(button): coloca text-white por padrão no botão * styles(app): organiza estilo principal do * web(components): básico popup escolha de matéria * web(DisciplineBox): adiciona trash icon * web(api): função para integrar busca de disciplina * schedules(layout): organiza estilo das páginas * web(home): usar 'ref' ao invés de 'document' js * web(home): cria secção de expandir p/cada matéria * web(components): cor de texto preta p/btn google * web(home): aside pop up como desligado por padrão * web(api): label (bool) p/expansão de disciplina * web(components): cria o pop de escolha de matéria * web(components): form de escolha/busca da matéria * web(components): padrão p/infos de sala da matéria * web(components): box para infos da disciplina * web(components): tooltip p/descrição dos horários * web(styles): tooltip * web(loading): component de carregamento de tela * web(contexts): handle das disciplinas selecionadas * web(components): proteção para rotas privadas * web(home): aparição das disciplinas selecionadas * web(schedules): rm profile link quando não logado * web(utils): mudança de tipagem de retorno na busca * web(app): criação da página de not-found (404) * bug(components): deep copy para evitar ref bug * fix(components): evita marcar aulas diff período * web(tooltip): generaliza os styles mobile/desktop * web(package): adiciona o lodash p/ deep copu * web(utils): padroniza o toast de erro * web(contexts): verifica o max de aulas/disciplinas * web(hooks): cria hook para pegar dimensões da tela * task(api): atualiza o frontend com as novas informações salvas de cada matéria na api (#125) * fix(Users): Corrige o erro de troca de nome de usuario. - Caso o usuario trocasse de nome no Google, o nome nao era salvo e o usuario nao conseguia logar. * fix(users-name-change): Os dados do usuário são sempre salvos após o login * api(views): update function calling in search api * db(migrations): install Trigram and pt_unaccent * db_handler(search): create new search function * test(db_handler): add test for new function * api(views): throw error when insufficient chars * api(tests): test for search api insufficient chars * make(database): Cria comandos make para atualizar o banco de dados. - Também foram corrigidos comentários no arquivo _updatedb.py_ * api(views): add rota de ano/período disponíveis Co-authored-by: GabrielCastelo-31 <[email protected]> * test(api): verifica retorno da rota ano/período * db(migrations): update migrations * db(models): update special_dates field * api(web-scraping): update functions add intervals * api(web-scraping): improve function complexity * python(requirements): add Unidecode * api(models): add unicode field to search improve * api(views): apply admin search method to endpoint * api(views): change name treatment to func * api(views): update search api - improve user exp * api(search-api-test): remove useless tests * utils(db-handler): update similarity function - also removes search by name function * utils(db-handler): remove useless tests * tests(year-period): add descrição ao teste * apí(commands): rm chars especiais do html do sigaa * api(mock): atualizando mock sem chars especiais * api(utils): melhora o entendimento do código * api(utils): cria func sep. p/start e end das datas * api(utils): separa func start end em duas de index * tests(setup.cfg): config codecov to ignore files * tests(codecov): add codecov "no cover" to ignore * Adiciona foto de perfil aos dados retornados. * docs(update-api): Atualiza os endpoints da API - Todos os endpoints sofrearam alterações Co-authored-by: mateusvrs <[email protected]> * main(readme): update README.md Co-authored-by: mateusvrs <[email protected]> * Update api/utils/web_scraping.py Co-authored-by: Gabriel Henrique Castelo <[email protected]> * Update api/utils/web_scraping.py Co-authored-by: Gabriel Henrique Castelo <[email protected]> * main(readme): remove embeds * Corrige erro causado após correção de tipagem de retorno. -Volta ao bc28e58 * Adiciona tipagem de retorno para funções de web scraping * applying and mergin migrations * fix(utils): get start e end index com return erro * main(readme): fix repo redirects * typo(tests): add pep8 * Revert "api(search): corrige experiência do usuário e adiciona verificações" * Revert "Revert "api(search): corrige experiência do usuário e adiciona verificações"" * docs(redoc): cria documentação integrada com swagger (#124) * python(requirements): adiciona drf_yasg * docs(users): descreve view de registro c/swagger * redoc(api): descreve views de search e year/period * docs(urls): adiciona rota do redoc e swagger * core(settings): swagger aos app django + rota 404 * api(templates): cria página 404 personalizada * docs(api): customiza erros com classe específica * docs(core): adiciona contribuidores ao docs da api * docs(swagger): classe p/padrão de response erros * docs(users): descreve view de login e logout * docs(api): simplifica classe de erro swagger * api(views): atualiza com novo método de filtragem * test(users): erros de acordo com novo padrão * test(config): no cover nos casos de except da docs --------- Co-authored-by: GabrielCastello-31 <[email protected]> Co-authored-by: Caio <[email protected]> Co-authored-by: Gabriel Henrique Castelo <[email protected]> * web(disciple): rm focus do input quando pesquisa * web(app): adiciona secção de horários especiais * web(tooltip): cria função para esc (sair da aba) * web(components): Espaçamento entre as disciplinas * refactor(home): modulariza a página home inicial * frontend(toastError):Erro caracteres insuficientes * web(Toast): Busca de materia invalida * refactor(context): remove complexidade cognitiva refactor(contexts): diminuindo complexidade refactor(components): modulariza form disciplina refactor(components): modulariza o popup de disciplinas refactor(app): simplifica e modulariza componentes refactor(context): modulariza seleção disciplina * web(home): integra ano/período c/ disponíveis api - a API apresenta uma rota GET que possibilita a busca de anos e períodos disponíveis para o usuário --------- Co-authored-by: Caio <[email protected]> Co-authored-by: Arthur Ribeiro <[email protected]> Co-authored-by: GabrielCastello-31 <[email protected]> Co-authored-by: Caio <[email protected]> Co-authored-by: Gabriel Henrique Castelo <[email protected]>
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.
Issue:
close #120
O que foi feito?