Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-824 Add Spring Restdocs Infrastructure #833

Closed
wants to merge 5 commits into from
Closed

gh-824 Add Spring Restdocs Infrastructure #833

wants to merge 5 commits into from

Conversation

ghillert
Copy link
Contributor

@ghillert ghillert commented Aug 22, 2016

Resolves #824
Resolves #821


[partintro]
--
In this section you will learn all about Spring Cloud Data Flows REST API.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Spring Cloud Data Flows

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moreover, and this goes beyond this simple PR, we should settle on Data Flow (here) or Dataflow (line 15), but not both

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be "Data Flow"

...and rather than adding an apostrophe above to make it possessive, it might be better to say:

all about the Spring Cloud Data Flow REST API.

@ericbottard
Copy link
Contributor

Overall, looks good, but I think it would be way more manageable if the tests were part of the -docs project.
The REST Docs tests can still be called *Tests btw, eg DocumentationTests. This would simplify configuration

@ghillert
Copy link
Contributor Author

ghillert commented Sep 7, 2016

Refactored the infrastructure so that the Rest Docs tests use a "representative" SCDF server instance. Also added more documentation. Should probably move the api documentation tests to the docs-modules.

*/
public class AppRegistryDocumentation extends BaseDocumentation {

@ClassRule
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can move up

@ghillert
Copy link
Contributor Author

ghillert commented Sep 9, 2016

Moved everything over to the spring-cloud-dataflow-docs module. More polishing and tests follow tomorrow.

@ericbottard
Copy link
Contributor

Awesome!
Let me know when it's ready to review/merge

*/
public class ApiDocumentation extends BaseDocumentation {

@ClassRule
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these can move up to the BaseDocumentation class

@ericbottard
Copy link
Contributor

Squashed and merged as e5db3d9 with some additional cleanup

@ericbottard ericbottard removed the in pr label Sep 13, 2016
corneil pushed a commit that referenced this pull request Mar 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants