Feature/rspec api documentation integration #269
Merged
Conversation
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
There was a problem hiding this comment.
Loved it!
What do you think of adding something like this https://github.com/juanmanuelramallo/target-mvd/blob/master/spec/support/devise_token_auth_overrides.rb to make the API Blueprint document always use the same access token and client id, just to avoid unnecessary changes in the document (?)
juanmanuelramallo
approved these changes
Oct 5, 2020
Co-authored-by: Juan Manuel Ramallo <[email protected]>
…com:rootstrap/rails_api_base into feature/rspec-api-documentation-integration
Co-authored-by: Juan Manuel Ramallo <[email protected]>
…com:rootstrap/rails_api_base into feature/rspec-api-documentation-integration
brunvez
approved these changes
Oct 6, 2020
guillermoap
added a commit
to guillermoap/rails_api_base
that referenced
this pull request
Oct 10, 2023
guillermoap
added a commit
that referenced
this pull request
Oct 24, 2023
…#472) * Revert "Merge pull request #269 from rootstrap/feature/rspec-api-documentation-integration" This reverts commit 84f3dbd, reversing changes made to f01515f. * Move featue-flags spec to /requests/admin * Add rspec-openapi * Initial doc * Using seed 1993 * Freeze test data for docs * Set docs with freezed data * Freeze devise auth token * Rubocop fixes * Create update docs script. Add it to CI to check for missing doc changes * Latest doc version * Do not change password reset token in specs * Fix code smell * Test changes * Make script trim whitespaces * Add docs workflow. Make bin/update-docs parallel * Remove docs from main CI * Set when action runs * Update label name * Setup autolabeler * Set new job for labeler * Set new worflow for labeler * Set condition for PR open * New update doc * Use new ruby script to update doc files * Set rspec-openapi path to handle parallel specs * Use new script and force to run with 8 cores * Use bundle exec to run script * Workflow fixes * Remove trailing whitespace * Run update-docs on push * Update workflow * Set cpu count for load schema * Handle ocassional errors. Clean files always * Fix parallel specs * Clear whitespaces from doc file * Remove update-docs bash file * Update update-docs action * Update README with doc * Fix endpoint in spec * Move CI docs to ci file * Change labeler config * Update labeler * Fix labeler * Move labeler to update docs action * Update docs labeler test * Use target * Use token * Run on merge with main or PR * Fix labeler path * Fix condition * Small fixes * README fixes * Remove unused api blueprint file * Clean up setup * Add comment to initializer * Rename action to check-docs * Sort endpoints alphabetically * Small improvements * Update docs * Make the default be parallelized * Stop freezing time in specs, set dates with regex in doc file * Update api_doc readme * Freeze timestamps via regex and not specs * Make doc check action run on pull_request and push on main * Update Docs and README * Use api_docs label * Remove unnecessary configs * Remove unnecessary permissions * Freeze timestamps in update-docs * Update rspec-openapi to v0.9 * Improve date freezing in script * Improve api_docs readme * Improve readme * Only run openapi initializer in test * Fix code climate for pull_request events * Make the CI commit doc changes * Rename update-docs script * Make CI update docs with parallelization on main push * Remove unnecessary canges to freeze test data * Update README * Remove changes from password spec * Skip feature flags for openapi * Update CI and docs * Add push key to bypass branch protections * Remove duplicate endpoints when merging docs * Copy changes to docs and ci * Remove duplicate permissions * Document ignoring specs
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.
Board:
Description:
This PR adds
rspec_api_documentationgem and all API endpoint acceptance specs to help us to auto-document it. IMO having this gem and the specs as an example will help us to encourage acceptance specs in the projects that use this base as a template, giving good documentation about their APIs.Notes:
aws-sdk-s3', '~> 1.75changed in gemfile to makebundle installworksRspecApiDocumentationinitializer has monkey patching to prevent an issue with Rails 6. (this has been already fixed in Documentation no longer include JSON response body when using with Rack >= 2.1.0 zipmark/rspec_api_documentation#456 and I'm waiting for a new release of the gem)apiary.apibis now generated by./bin/docstask