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

State Machine Description #290

zdne opened this Issue Dec 10, 2015 · 1 comment


None yet
2 participants
Copy link

zdne commented Dec 10, 2015

Following the Resource Blueprint Concept the API Blueprint should offer description of the API state machine.

This will benefit both the conceptual design of an API and the testing of its implementation. Enabling next generation of tools such as powerful mocks or implementation generators.

If an API client is following the REST principles it is essential that it does not utilize any knowledge of the state machine as that should be driven completely by the server (HATEOAS).

# Resource Blog Post
- attributes

## Action Retrieve Blog Post
- relation: list (self)

## Action Edit Blog Post
- relation: edit

## Action Archive Blog Post
- relation: archive 

## Action Unarchive Blog Post
- relation: unarchive 

## States
- active
   - Affordances
       - list -> active
       - edit -> active
       - archive -> archived

- archived
    - Affordances
        - list -> archived
        - unarchive -> active

See the Resource Blueprint concept for details on the possible design of this feature.

Related issue #13


This comment has been minimized.

Copy link

pksunkara commented Dec 10, 2015

I know it is just a sketch but something like this would be better:

- archived
    - Affordances
        - list: archived
        - unarchive: active
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment