Skip to content
Snippets Groups Projects

Add information about api4 changes

Merged Add information about api4 changes
github/fork/colemanw/api4-changes into master
Merged homotechsual requested to merge github/fork/colemanw/api4-changes into master

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
    homotechsual @homotechsual started a thread on commit 1ce6312b
    • docs/api/v4/differences-with-v3.md
    1 # Differences between API v3 and v4
    2
    3 APIv4 is broadly similar to APIv3. Both are designed for reading and writing data.
    4 Both use *entities*, *actions*, and *parameters*. However, APIv4 is specifically a
    5 breaking-change which aims to reduce *ambiguity* and improve *flexibility* and *consistency*.
    6
    7 This document walks through a list of specific differences. As you consider
    8 them, it may help to have a concrete example expressed in both APIv3 and
    9 APIv4:
    10
    11 <!-- Would be nice if Markdown made it easier to do side-by-side comparison... -->
    • homotechsual
      homotechsual @homotechsual
      Author Owner

      We can do tables with the "pipe" syntax - if you wrap that inside a code block you can get highlighting - with, for example, "diff" style red/green highlighting as required or with support for code highlight blocks within cells.

      https://squidfunk.github.io/mkdocs-material/extensions/codehilite/#usage

      | Header 1 | Header 2 | Header 3 |
| ---------- | ---------- | ---------- |
| Cell 1 | Cell 2 | Cell 3 |
      Header 1 Header 2 Header 3
      Cell 1 Cell 2 Cell 3

      Simple tables are workable - complex tables - not so much!

  • homotechsual
    homotechsual @homotechsual started a thread on commit 1ce6312b
    • docs/api/v4/differences-with-v3.md
    1 # Differences between API v3 and v4
    2
    3 APIv4 is broadly similar to APIv3. Both are designed for reading and writing data.
    4 Both use *entities*, *actions*, and *parameters*. However, APIv4 is specifically a
    5 breaking-change which aims to reduce *ambiguity* and improve *flexibility* and *consistency*.
    6
    7 This document walks through a list of specific differences. As you consider
    8 them, it may help to have a concrete example expressed in both APIv3 and
    9 APIv4:
    10
    11 <!-- Would be nice if Markdown made it easier to do side-by-side comparison... -->
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
  • homotechsual
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
    • Please register or sign in to reply